/*******************************************************************************
* Copyright (c) 2000, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.internal.ui.refactoring.actions;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.text.ITextSelection;
import org.eclipse.ui.IWorkbenchSite;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IPackageFragment;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.dom.ASTNode;
import org.eclipse.jdt.core.dom.SimpleName;
import org.eclipse.jdt.core.refactoring.IJavaRefactorings;
import org.eclipse.jdt.internal.corext.refactoring.RefactoringAvailabilityTester;
import org.eclipse.jdt.internal.corext.refactoring.RefactoringExecutionStarter;
import org.eclipse.jdt.internal.corext.refactoring.codingspectator.RefactoringGlobalStore;
import org.eclipse.jdt.internal.corext.util.JavaModelUtil;
import org.eclipse.jdt.ui.PreferenceConstants;
import org.eclipse.jdt.ui.actions.SelectionDispatchAction;
import org.eclipse.jdt.ui.actions.codingspectator.UnavailableRefactoringLogger;
import org.eclipse.jdt.internal.ui.JavaPlugin;
import org.eclipse.jdt.internal.ui.actions.ActionUtil;
import org.eclipse.jdt.internal.ui.actions.SelectionConverter;
import org.eclipse.jdt.internal.ui.javaeditor.CompilationUnitEditor;
import org.eclipse.jdt.internal.ui.javaeditor.EditorUtility;
import org.eclipse.jdt.internal.ui.javaeditor.JavaEditor;
import org.eclipse.jdt.internal.ui.javaeditor.JavaTextSelection;
import org.eclipse.jdt.internal.ui.refactoring.RefactoringMessages;
import org.eclipse.jdt.internal.ui.refactoring.reorg.RenameLinkedMode;
import org.eclipse.jdt.internal.ui.text.correction.CorrectionCommandHandler;
import org.eclipse.jdt.internal.ui.text.correction.proposals.LinkedNamesAssistProposal;
import org.eclipse.jdt.internal.ui.util.ExceptionHandler;
/**
*
* @authors Mohsen Vakilian, nchen: Logged refactoring unavailability. Added a flag to indicate the
* quick assist origin of the refactoring.
*/
public class RenameJavaElementAction extends SelectionDispatchAction {
private JavaEditor fEditor;
private boolean invokedByQuickAssist= false;
public RenameJavaElementAction(IWorkbenchSite site) {
super(site);
}
public RenameJavaElementAction(JavaEditor editor) {
this(editor.getEditorSite());
fEditor= editor;
setEnabled(SelectionConverter.canOperateOn(fEditor));
}
//CODINGSPECTATOR: Record the quick assist origin of the refactoring.
public RenameJavaElementAction(JavaEditor editor, boolean invokedByQuickAssist) {
this(editor);
this.invokedByQuickAssist= invokedByQuickAssist;
}
//---- Structured selection ------------------------------------------------
@Override
public void selectionChanged(IStructuredSelection selection) {
try {
if (selection.size() == 1) {
setEnabled(canEnable(selection));
return;
}
} catch (JavaModelException e) {
// http://bugs.eclipse.org/bugs/show_bug.cgi?id=19253
if (JavaModelUtil.isExceptionToBeLogged(e))
JavaPlugin.log(e);
} catch (CoreException e) {
JavaPlugin.log(e);
}
setEnabled(false);
}
private static boolean canEnable(IStructuredSelection selection) throws CoreException {
IJavaElement element= getJavaElement(selection);
if (element == null)
return false;
return RefactoringAvailabilityTester.isRenameElementAvailable(element);
}
private static IJavaElement getJavaElement(IStructuredSelection selection) {
if (selection.size() != 1)
return null;
Object first= selection.getFirstElement();
if (!(first instanceof IJavaElement))
return null;
return (IJavaElement) first;
}
@Override
public void run(IStructuredSelection selection) {
//CODINGSPECTATOR
RefactoringGlobalStore.getNewInstance().setStructuredSelection(selection);
IJavaElement element= getJavaElement(selection);
if (element == null)
return;
if (!ActionUtil.isEditable(getShell(), element))
return;
try {
run(element, false);
} catch (CoreException e) {
ExceptionHandler.handle(e, RefactoringMessages.RenameJavaElementAction_name, RefactoringMessages.RenameJavaElementAction_exception);
}
}
//---- text selection ------------------------------------------------------------
@Override
public void selectionChanged(ITextSelection selection) {
if (selection instanceof JavaTextSelection) {
try {
JavaTextSelection javaTextSelection= (JavaTextSelection) selection;
IJavaElement[] elements= javaTextSelection.resolveElementAtOffset();
if (elements.length == 1) {
setEnabled(RefactoringAvailabilityTester.isRenameElementAvailable(elements[0]));
} else {
ASTNode node= javaTextSelection.resolveCoveringNode();
setEnabled(node instanceof SimpleName);
}
} catch (CoreException e) {
setEnabled(false);
}
} else {
setEnabled(true);
}
}
@Override
public void run(ITextSelection selection) {
if (!ActionUtil.isEditable(fEditor))
return;
if (canRunInEditor())
doRun();
else
MessageDialog.openInformation(getShell(), RefactoringMessages.RenameAction_rename, RefactoringMessages.RenameAction_unavailable);
}
public void doRun() {
ISelection selection= fEditor.getSelectionProvider().getSelection();
//Initialize the global store in doRun as opposed to run(ITextSelection) because doRun
//is also invoked in org.eclipse.jdt.internal.ui.text.correction.proposals.RenameRefactoringProposal.apply(IDocument)
RefactoringGlobalStore.getNewInstance().setEditorSelectionInfo(EditorUtility.getEditorInputJavaElement(fEditor, false), (ITextSelection) selection);
RenameLinkedMode activeLinkedMode= RenameLinkedMode.getActiveLinkedMode();
if (activeLinkedMode != null) {
if (activeLinkedMode.isCaretInLinkedPosition()) {
activeLinkedMode.startFullDialog();
return;
} else {
activeLinkedMode.cancel();
}
}
IJavaElement element= null;
try {
element= getJavaElementFromEditor();
IPreferenceStore store= JavaPlugin.getDefault().getPreferenceStore();
boolean lightweight= store.getBoolean(PreferenceConstants.REFACTOR_LIGHTWEIGHT);
if (element != null && RefactoringAvailabilityTester.isRenameElementAvailable(element)) {
run(element, lightweight);
return;
} else if (lightweight) {
// fall back to local rename:
CorrectionCommandHandler handler= new CorrectionCommandHandler(fEditor, LinkedNamesAssistProposal.ASSIST_ID, true);
if (handler.doExecute()) {
fEditor.setStatusLineErrorMessage(RefactoringMessages.RenameJavaElementAction_started_rename_in_file);
return;
}
}
} catch (CoreException e) {
ExceptionHandler.handle(e, RefactoringMessages.RenameJavaElementAction_name, RefactoringMessages.RenameJavaElementAction_exception);
}
//CODINGSPECTATOR
UnavailableRefactoringLogger.logUnavailableRefactoringEvent(IJavaRefactorings.RENAME_UNKNOWN_JAVA_ELEMENT, RefactoringMessages.RenameJavaElementAction_not_available);
MessageDialog.openInformation(getShell(), RefactoringMessages.RenameJavaElementAction_name, RefactoringMessages.RenameJavaElementAction_not_available);
}
public boolean canRunInEditor() {
if (RenameLinkedMode.getActiveLinkedMode() != null)
return true;
try {
IJavaElement element= getJavaElementFromEditor();
if (element == null)
return true;
return RefactoringAvailabilityTester.isRenameElementAvailable(element);
} catch (JavaModelException e) {
if (JavaModelUtil.isExceptionToBeLogged(e))
JavaPlugin.log(e);
} catch (CoreException e) {
JavaPlugin.log(e);
}
return false;
}
private IJavaElement getJavaElementFromEditor() throws JavaModelException {
IJavaElement[] elements= SelectionConverter.codeResolve(fEditor);
if (elements == null || elements.length != 1)
return null;
return elements[0];
}
//---- helper methods -------------------------------------------------------------------
private void run(IJavaElement element, boolean lightweight) throws CoreException {
// Work around for http://dev.eclipse.org/bugs/show_bug.cgi?id=19104
if (!ActionUtil.isEditable(fEditor, getShell(), element))
return;
//XXX workaround bug 31998
if (ActionUtil.mustDisableJavaModelAction(getShell(), element))
return;
if (lightweight && fEditor instanceof CompilationUnitEditor && !(element instanceof IPackageFragment)) {
//CODINGSPECTATOR: Pass along the quick assist origin of the refactoring.
new RenameLinkedMode(element, (CompilationUnitEditor) fEditor, invokedByQuickAssist).start();
} else {
//CODINGSPECTATOR: Pass along the quick assist origin of the refactoring.
RefactoringExecutionStarter.startRenameRefactoring(element, getShell(), invokedByQuickAssist);
}
}
}